home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / games1 / btma120.zip / BTMAEDIT.DOC < prev    next >
Text File  |  1993-01-13  |  10KB  |  220 lines
  1. BATTLETECH MAP EDITOR
  2. Version 1.2
  3. -----------------------------------------------------------------
  4. Code, Graphics by Brian Futrell
  5. Sprite overlapping routine by Fred Sexton Jr (QB News Vol 2, No 3)
  6. Other routines from PBClone QuickBASIC library v1.7 (registered)
  7.   by Thomas G. Hanlin III
  8. Battletech is a trademark of FASA Corporation.
  9. QuickBASIC is a trademark of Microsoft Corp.
  10.  
  11. NOTICE!!!
  12. =========
  13. This program is SHAREWARE.  This means that a person or a group of people
  14. decided to release this software on a "try before you buy" basis.  Try the
  15. program out for thrity (30) days.  If you continue to use the program after
  16. that, send a $10.00 check or money order to:
  17.  
  18.     Brian Futrell
  19.     2633 Pleasant Hill Dr.
  20.     Zebulon, NC 27597
  21.  
  22. Registered users do not have to register future updates of this program and
  23. get rid of the annoying screens that appear when exiting the program.
  24.  
  25. WARRANTY
  26. ========
  27. This program is distributed AS IS, meaning that there is no warranty of any
  28. kind attached to this program.  I, Brian Futrell, am not responsible if this
  29. program damages your computer (it shouldn't) or is not suited to a particular
  30. task.  I have tried the program on my computer (a 386 operating at 40 and 16
  31. mhz) and the program has worked without difficulty.
  32.  
  33. PROGRAM REQUIREMENTS
  34. ====================
  35. A knowledge of the Battletech science fiction combat game,
  36. An IBM PC/XT/AT/386/486 with 512k of memory (AT or above recommended),
  37. A Microsoft or compatable mouse and mouse driver,
  38. A MCGA/VGA video graphics card and monitor,
  39. A 720k or higher capacity floppy disk or hard drive (hard drive recommended)
  40. Also recommended is a disk cache of approximately 512k to speed up disk
  41. operations.
  42.  
  43. PROGRAM FILES
  44. =============
  45. The following files are found in the archive.  All of them must be present,
  46. with the exception of the documentation, in order for the program to work
  47. properly.
  48.  
  49. BTASHAPE.ARY            BTMAEDIT.EXE            BTMASHP1.DAT            
  50. CMAP.BOX                CREDITS.BOX             DISK.BUT
  51. DISKBOX.ARY             EBUTTON.ARY             EDIT.BUT
  52. ERASE.BUT               ETEXT.BUT               EXITP.BOX
  53. GCHARS.ARY              LARGEEND.ARY            LSBUTS.ARY                      
  54. MANAMES.DAT             MAP1.DAT                MAP2.DAT                    
  55. MAP3.DAT                MAP4.DAT                MAP5.DAT                    
  56. MAP6.DAT                MAP7.DAT                MAP8.DAT                    
  57. MAPPLAQ1.BOX            MAPPLAQ2.BOX            MMCLRS.CLR                      
  58. MMENU.ARY               OMENU.ARY               OOPS.BOX                   
  59. OTHER.BUT               OVERWRIT.BOX            OVERWRIT.BUT
  60. RZMAP.BOX               SIZEMAP.BUT             SMALLEND.ARY
  61. TENTRY.BOX
  62.  
  63. Also, when maps are saved and there are no previously stored ones on the disk, 
  64. extra files are created.  MANAMES.DAT is the file that stores the names of
  65. every map in the directory.  Mapxx.DAT is the actual map file where xx is a
  66. number from 1 to 9999.
  67.  
  68. STARTING THE PROGRAM
  69. ====================
  70. To load the program, go to the drive and directory that the program is stored
  71. in and type BTMAEDIT.  The program will then check for a mouse and a VGA/MCGA
  72. graphics card.  If the program finds both of the forementioned items, it will
  73. load data into the computer's memory, then display the title screen.  To start
  74. editing maps, press the OK button.  To exit back to dos, press the EXIT 
  75. button.
  76.  
  77. THE SCREEN
  78. ==========
  79. The screen is divided into two sections, as shown below:
  80.  
  81.       +----------------------+---------+
  82.       |                      |         |
  83.       |                      |         |
  84.       |                      |  Menu   |
  85.       |         Map          |         |
  86.       |                      |         |
  87.       |         Area         |         |
  88.       |                      |  Area   |
  89.       |                      |         |
  90.       |                      |         |
  91.       |                      |         |
  92.       +----------------------+---------+
  93.  
  94. The Map Area is where a portion of the map is displayed.  To scroll around the
  95. map, use the blue arrows on the top of the Menu Area.  The name of the map is
  96. displayed at the bottom of the screen in the Map Area.
  97.  
  98. The Menu Area is where you can alter the map and scroll through it.  Each of 
  99. the items will be described in detail below, althoug I have tried to make this
  100. program as easy to use as possible.
  101.  
  102. MAIN MENU
  103. =========
  104. The main menu conatins everything neccessary to edit the map.  To do other 
  105. things, like resizing the map, naming the map, and disk operations use another
  106. menu.
  107.  
  108. +-----------+    Directional Arrows (arrows are Blue):
  109. |     ^     |    -------------------------------------
  110. +-----+-----+    These buttons scroll the map in the direction indicated.
  111. |  <<  |  >  |    When scrolling, the coordinate window will change.  This is
  112. +-----+-----+    the coordinate of the upper-left hex.
  113. |     v     |
  114. +-----------+
  115.  
  116. +-----+-----+    Terrain Buttons
  117. |     |     |    ---------------
  118. |     |     |    These buttons select the type of terrain that will be placed
  119. +-----+-----+    on the map if your cursor is in a hex when the mouse button
  120.          is pressed.  The selected terrain will have a green square
  121.          beside it.
  122.  
  123. +-----+-----+    Level Buttons
  124. |  ^  |\---/|    -------------
  125. | / \ | \ / |    These buttons raise and lower the level of the terrain
  126. |/---\|  v  |    affected by the terrain buttons.  When these are pressed,
  127. +-----+-----+    all of the terrain types will visibly change to indicate
  128.          the level selected.
  129.  
  130. +-----------+    Other Button
  131. | /\        |    ------------
  132. | \/ther    |    This button displays the menu in place of the main menu.
  133. +-----------+    Each of the options will be explained in detail in the
  134.          OTHER MENU area in the document.
  135.  
  136. OTHER MENU
  137. ==========
  138. This is where all of the non-editing tasks are performed.  This is also where
  139. the program is exited from.
  140.  
  141. +-----------+    Name Button
  142. |   NAME    |    -----------
  143. +-----------+    This is where you edit the name of your map.  Use the cursor
  144.          keys to move the cursor and type your map name in.  ENTER
  145.          changes the name of your map to the one that was typed.  ESC
  146.          keeps the name of you map to what is was previously.
  147.  
  148.          The mouse cursor can also be used.  To place the text cursor
  149.          under a specific position, move the mouse cursor to the
  150.          location and press either mouse button.  To accept the text,
  151.          press the OK button.  To abort, press the EXIT button.
  152.  
  153. +----------+     Resize Map Button
  154. | +------+ |     -----------------
  155. | +---+  | |     This button resizes the map into one of four configurations:
  156. | |   |  | |       16 hexes wide by 17 hexes long,
  157. | +---+--+ |       32 hexes wide by 17 hexes long,
  158. +----------+       16 hexes wide by 34 hexes long,
  159.            32 hexes wide by 34 hexes long.
  160.          SELECTING A MAP SIZE WILL CLEAR THE MAP!!!!!
  161.  
  162. +-----------+    Erase Map Button
  163. | +-------+ |    ----------------
  164. | +-------+ |    This button will ask for confirmation before earsing the map.
  165. | |       | |    To continue and erase the map press the YES button.  To
  166. +-----------+    To abort the erasure, press the EXIT button.
  167.  
  168. +-----------+    Load Map Button
  169. |    +-----+|    ---------------
  170. |<<- |  o  ||    This button displays a list of the files in the directory.
  171. |    +__|__+|    To load a file, press the mouse button when the cursor is on
  172. +-----------+    one of the filenames.  The box beside the filenaame will
  173.  
  174.  
  175. +-----------+    Load Map Button
  176. |    +-----+|    ---------------
  177. |<<- |  o  ||    This button displays a list of the files in the directory.
  178. |    +__|__+|    To load a file, press the mouse button when the cursor is on
  179. +-----------+    one of the filenames.  The box beside the filenaame will
  180.          light up indicating that the file has been selected.  To load 
  181.          that file, press the LOAD button on the right of the file 
  182.          list.  If there are more than 12 filenames, You can scroll up 
  183.          and down the file list by pressing the up and down arrow to 
  184.          the right of the file list.
  185.  
  186. +-----------+    Save Map Button
  187. |    +-----+|    ---------------
  188. | -> |  o  ||    This button displays a list of the files in the directory.
  189. |    +--|--||    To save the map as a mew one, press the NEW button and the 
  190. +-----------+    file list will be automatically updated.  To overwrite an 
  191.          existing map, press the mouse button when the cursor is over 
  192.          the filename.  The square beside the filename will light up,               
  193.          indicating that the filename has been selected.  Then press  
  194.          the SAVE button.  A menu will come up asking if you want to 
  195.          overwrite the file.  To overwrite the file, press the YES  
  196.          button.  To abort, press the NO button.
  197.  
  198. +-----------+    Credits Button
  199. |    --/    |    --------------
  200. |     /     |    This button displays the program credits.  To exit this 
  201. |    /-     |    simply press either mouse button.
  202. +-----------+
  203.  
  204. +-----------+    Mini Map Button
  205. | +------+  |    ---------------
  206. | |      |  |    This button displays a scaled-down view of the map.  Each
  207. | +------+  |    type of terrain is represented by a diffrent color.  Once the
  208. +-----------+    map has been displayed, press either mouse button to exit.
  209.  
  210. +-----------+    Exit Other Button
  211. |   EXIT    |    -----------------
  212. |   OTHER   |    This button exits the OTHER MENU and re-enters the Main Menu.
  213. +-----------+
  214.  
  215. +-----------+    Exit All
  216. |   EXIT    |    --------
  217. |    ALL    |    This button will exit the program to DOS, but it will first 
  218. +-----------+    ask for confirmation.  To exit to DOS, press YES.  To abort, 
  219.          press EXIT.
  220.